Add a section to the intro on getting help#1100
Merged
ineelhere merged 2 commits intoswcarpentry:mainfrom May 7, 2025
Merged
Conversation
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/swcarpentry/python-novice-inflammation/compare/md-outputs..md-outputs-PR-1100 The following changes were observed in the rendered markdown documents: What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2025-05-07 13:17:17 +0000 |
ineelhere
approved these changes
May 7, 2025
github-actions Bot
pushed a commit
that referenced
this pull request
May 7, 2025
Auto-generated via `{sandpaper}`
Source : 696d478
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-05-07 15:40:46 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : bb3690c
Branch : main
Author : Indraneel Chakraborty <64887729+ineelhere@users.noreply.github.com>
Time : 2025-05-07 15:40:04 +0000
Message : Merge pull request #1100 from tobyhodges/llm-assistants
Add a section to the intro on getting help
github-actions Bot
pushed a commit
that referenced
this pull request
May 13, 2025
Auto-generated via `{sandpaper}`
Source : 696d478
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-05-07 15:40:46 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : bb3690c
Branch : main
Author : Indraneel Chakraborty <64887729+ineelhere@users.noreply.github.com>
Time : 2025-05-07 15:40:04 +0000
Message : Merge pull request #1100 from tobyhodges/llm-assistants
Add a section to the intro on getting help
github-actions Bot
pushed a commit
that referenced
this pull request
May 13, 2025
Auto-generated via `{sandpaper}`
Source : 696d478
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-05-07 15:40:46 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : bb3690c
Branch : main
Author : Indraneel Chakraborty <64887729+ineelhere@users.noreply.github.com>
Time : 2025-05-07 15:40:04 +0000
Message : Merge pull request #1100 from tobyhodges/llm-assistants
Add a section to the intro on getting help
github-actions Bot
pushed a commit
that referenced
this pull request
May 20, 2025
Auto-generated via `{sandpaper}`
Source : 696d478
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-05-07 15:40:46 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : bb3690c
Branch : main
Author : Indraneel Chakraborty <64887729+ineelhere@users.noreply.github.com>
Time : 2025-05-07 15:40:04 +0000
Message : Merge pull request #1100 from tobyhodges/llm-assistants
Add a section to the intro on getting help
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a new section to the first episode about how to get help with writing & debugging Python, including a discussion of generative AI in this context. It is based on the changes made and discussed in swcarpentry/python-novice-gapminder#697 (and in various other communication channels -- please see the linked PR thread for more details)
This moves the first mention of the built-in
helpfunction earlier in the lesson (it was previously in episode 8), and briefly discusses some things that are then covered in more depth in the Debugging episode.This might feel redundant but IMO it is sensible to discuss strategies for getting help early in the lesson. Furthermore, the guidance added here about how (not) to use LLM assistants while learning to code needs to appear early on.
This adds a large block of (seemingly) new content. However, most Instructors are presumably spending time covering these points in workshops already. The changes formalise that in the lesson, making it more useful for self-directed learners following it outside a workshop setting.